[%#
  # IMPORTANT NOTE
  #   This documentation is generated automatically from source
  #   templates.  Any changes you make here may be lost.
  # 
  #   The 'docsrc' documentation source bundle is available for download
  #   from http://www.template-toolkit.org/docs.html and contains all
  #   the source templates, XML files, scripts, etc., from which the
  #   documentation for the Template Toolkit is built.
-%]
[% META book = 'Modules'
        page = 'Document'
%]
[%  WRAPPER toc;
	PROCESS tocitem 
	        title ="SYNOPSIS"
                subs  = [];
	PROCESS tocitem 
	        title ="DESCRIPTION"
                subs  = [];
	PROCESS tocitem 
	        title ="METHODS"
                subs  = [
                    "new(\\%config)",
		    "process(\$context)",
		    "block()",
		    "blocks()",
		    "AUTOLOAD"
		];
	PROCESS tocitem 
	        title ="PACKAGE SUB-ROUTINES"
                subs  = [
                    "write_perl_file(\\%config)"
		];
	PROCESS tocitem 
	        title ="AUTHOR"
                subs  = [];
	PROCESS tocitem 
	        title ="VERSION"
                subs  = [];
	PROCESS tocitem 
	        title ="COPYRIGHT"
                subs  = [];
	PROCESS tocitem 
	        title ="SEE ALSO"
                subs  = [];
    END
%]
<!-- Pod to HTML conversion by the Template Toolkit version 2 -->
[% WRAPPER section
    title="SYNOPSIS"
-%]<pre>    use Template::Document;</pre>
<pre>    $doc = Template::Document-&gt;new({
	BLOCK =&gt; sub { # some perl code; return $some_text },
	DEFBLOCKS =&gt; {
	    header =&gt; sub { # more perl code; return $some_text },
	    footer =&gt; sub { # blah blah blah; return $some_text },
	},
	METADATA =&gt; {
	    author  =&gt; 'Andy Wardley',
	    version =&gt; 3.14,
	}
    }) || die $Template::Document::ERROR;</pre>
<pre>    print $doc-&gt;process($context);</pre>
[%- END %]
[% WRAPPER section
    title="DESCRIPTION"
-%]<p>
This module defines an object class whose instances represent compiled
template documents.  The Template::Parser module creates a
Template::Document instance to encapsulate a template as it is compiled
into Perl code.
</p>
<p>
The constructor method, new(), expects a reference to a hash array
containing the BLOCK, DEFBLOCKS and METADATA items.  The BLOCK item
should contain a reference to a Perl subroutine or a textual
representation of Perl code, as generated by the Template::Parser
module, which is then evaluated into a subroutine reference using
eval().  The DEFLOCKS item should reference a hash array containing
further named BLOCKs which may be defined in the template.  The keys
represent BLOCK names and the values should be subroutine references
or text strings of Perl code as per the main BLOCK item.  The METADATA
item should reference a hash array of metadata items relevant to the
document.
</p>
<p>
The process() method can then be called on the instantiated
Template::Document object, passing a reference to a Template::Content
object as the first parameter.  This will install any locally defined
blocks (DEFBLOCKS) in the the contexts() BLOCKS cache (via a call to
visit()) so that they may be subsequently resolved by the context.  The 
main BLOCK subroutine is then executed, passing the context reference
on as a parameter.  The text returned from the template subroutine is
then returned by the process() method, after calling the context leave()
method to permit cleanup and de-registration of named BLOCKS previously
installed.
</p>
<p>
An AUTOLOAD method provides access to the METADATA items for the document.
The Template::Service module installs a reference to the main 
Template::Document object in the stash as the 'template' variable.
This allows metadata items to be accessed from within templates, 
including PRE_PROCESS templates.
</p>
<p>
header:
</p>
<pre>    &lt;html&gt;
    &lt;head&gt;
    &lt;title&gt;[% tt_start_tag %] template.title [% tt_end_tag %]
    &lt;/head&gt;
    ...</pre>
<p>
Template::Document objects are usually created by the Template::Parser
but can be manually instantiated or sub-classed to provide custom
template components.
</p>
[%- END %]
[% WRAPPER section
    title="METHODS"
-%][% WRAPPER subsection
   title = "new(\\%config)"
-%]<p>
Constructor method which accept a reference to a hash array containing the
structure as shown in this example:
</p>
<pre>    $doc = Template::Document-&gt;new({
	BLOCK =&gt; sub { # some perl code; return $some_text },
	DEFBLOCKS =&gt; {
	    header =&gt; sub { # more perl code; return $some_text },
	    footer =&gt; sub { # blah blah blah; return $some_text },
	},
	METADATA =&gt; {
	    author  =&gt; 'Andy Wardley',
	    version =&gt; 3.14,
	}
    }) || die $Template::Document::ERROR;</pre>
<p>
BLOCK and DEFBLOCKS items may be expressed as references to Perl subroutines
or as text strings containing Perl subroutine definitions, as is generated
by the Template::Parser module.  These are evaluated into subroutine references
using eval().
</p>
<p>
Returns a new Template::Document object or undef on error.  The error() class
method can be called, or the $ERROR package variable inspected to retrieve
the relevant error message.
</p>
[%- END %]
[% WRAPPER subsection
   title = "process(\$context)"
-%]<p>
Main processing routine for the compiled template document.  A reference to 
a Template::Context object should be passed as the first parameter.  The 
method installs any locally defined blocks via a call to the context 
visit() method, processes it's own template, passing the context reference
by parameter and then calls leave() in the context to allow cleanup.
</p>
<pre>    print $doc-&gt;process($context);</pre>
<p>
Returns a text string representing the generated output for the template.
Errors are thrown via die().
</p>
[%- END %]
[% WRAPPER subsection
   title = "block()"
-%]<p>
Returns a reference to the main BLOCK subroutine.
</p>
[%- END %]
[% WRAPPER subsection
   title = "blocks()"
-%]<p>
Returns a reference to the hash array of named DEFBLOCKS subroutines.
</p>
[%- END %]
[% WRAPPER subsection
   title = "AUTOLOAD"
-%]<p>
An autoload method returns METADATA items.
</p>
<pre>    print $doc-&gt;author();</pre>
[%- END %]
[%- END %]
[% WRAPPER section
    title="PACKAGE SUB-ROUTINES"
-%][% WRAPPER subsection
   title = "write_perl_file(\\%config)"
-%]<p>
This package subroutine is provided to effect persistence of compiled
templates.  If the COMPILE_EXT option (to indicate a file extension
for saving compiled templates) then the Template::Parser module calls
this subroutine before calling the new() constructor.  At this stage,
the parser has a representation of the template as text strings
containing Perl code.  We can write that to a file, enclosed in a
small wrapper which will allow us to susequently require() the file
and have Perl parse and compile it into a Template::Document.  Thus we
have persistence of compiled templates.
</p>
[%- END %]
[%- END %]
[% WRAPPER section
    title="AUTHOR"
-%]<p>
Andy Wardley &lt;abw@wardley.org&gt;
</p>
<p>
[% ttlink('http://wardley.org/', 'http://wardley.org/') -%]
</p>
[%- END %]
[% WRAPPER section
    title="VERSION"
-%]<p>
2.79, distributed as part of the
Template Toolkit version 2.19, released on 27 April 2007.
</p>
[%- END %]
[% WRAPPER section
    title="COPYRIGHT"
-%]<pre>  Copyright (C) 1996-2007 Andy Wardley.  All Rights Reserved.</pre>
<p>
This module is free software; you can redistribute it and/or
modify it under the same terms as Perl itself.
</p>
[%- END %]
[% WRAPPER section
    title="SEE ALSO"
-%]<p>
[% ttlink('Template', 'Template') -%], [% ttlink('Template::Parser', 'Template::Parser') -%]
</p>
[%- END %]



